.. _CGameEffectEffect Class: ============================ CGameEffect Classes ============================ * :ref:`Overview` * :ref:`Methods` * :ref:`Notes` * :ref:`Specific CGameEffect\ Classes` ---- .. _CGameEffectEffect_Overview: Overview --------------- .. note:: There are lots of game effect classes that are similar in definition. Rather than document each one individually, there are all referenced here collectively instead. **CGameEffect**\ classes handle specific effects, where *\* is a placeholder for the game effect name. .. note:: Please see the :ref:`CGameEffect Structures` section for a game effect structure used by a specific game effect class. .. tip:: See :ref:`Notes` for details of the game effect classes, that the class methods documented here apply to. See :ref:`Specific CGameEffect\ Classes` for classes that share the same methods as the others listed, but have additional class methods as well. ---- .. _CGameEffectEffect_Methods: Methods --------------- +--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | **Name**\* | **Description** | +--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CGameEffect\\:\:CGameEffect\` | Constructor for a specific game effect | +--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CGameEffect\\:\:ApplyEffect` | Apply effect | +--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CGameEffect\\:\:Copy` | Copy effect | +--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ \* *\* is a placeholder for the game effect name ---- .. _CGameEffectEffectCGameEffectEffect: CGameEffect\\:\:CGameEffect\ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Constructs a specific game effect object :: void CGameEffect::CGameEffect( Item_effect_st* effect, CPoint& source, long sourceID, CPoint target); **Parameters** * :ref:`Item_effect_st`\* *effect* - * :ref:`CPoint`\& *source* - * ``long`` *sourceID* - * :ref:`CPoint` *target* - **Remarks** Constructor for a specific game effect. See :ref:`Notes` for the specific class names this applies to. Example: ``CGameEffectEntangle::CGameEffectEntangle(effect,source,sourceID,target);`` ---- .. _CGameEffectEffectApplyEffect: CGameEffect\\:\:ApplyEffect ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual int CGameEffect::ApplyEffect(CGameSprite* pSprite); **Parameters** * :ref:`CGameSprite`\* *pSprite* - pointer to game sprite object **Return Value** Returns ``int`` **Remarks** See :ref:`Notes` for the specific class names this applies to. Example: ``virtual int CGameEffectEntangle::ApplyEffect(CGameSprite* pSprite);`` ---- .. _CGameEffectEffectCopy: CGameEffect\\:\:Copy ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Copy game effect :: virtual CGameEffect* CGameEffect::Copy(); **Return Value** Returns :ref:`CGameEffect`\* **Remarks** See :ref:`Notes` for the specific class names this applies to. Example: ``virtual CGameEffect* CGameEffectEntangle::Copy();`` ---- .. _CGameEffectEffect_Notes: Notes --------------- .. note:: CGameEffect\ used in the documentation above is a placeholder for the actual class name, as listed below. The following class names apply to the documented class methods above as the share the same basic methods and a constructor for each class: * :ref:`CGameEffectAC` * :ref:`CGameEffectAIChange` * :ref:`CGameEffectAddInnateAbility` * :ref:`CGameEffectAlignmentChange` * :ref:`CGameEffectApplyEffectEquipItemType` * :ref:`CGameEffectApplyEffectEquipItem` * :ref:`CGameEffectApplySpellOnMove` * :ref:`CGameEffectApplySpell` * :ref:`CGameEffectAssassination` * :ref:`CGameEffectAttackNo` * :ref:`CGameEffectAuraCleansing` * :ref:`CGameEffectAwaken` * :ref:`CGameEffectBackStabMod` * :ref:`CGameEffectBackStabSpell` * :ref:`CGameEffectBardSong` * :ref:`CGameEffectBerserkStage1` * :ref:`CGameEffectBerserkStage2` * :ref:`CGameEffectBerserk` * :ref:`CGameEffectBlur` * :ref:`CGameEffectBounceEffect` * :ref:`CGameEffectBounceLevel` * :ref:`CGameEffectBounceProjectile` * :ref:`CGameEffectBounceSchoolDecrement` * :ref:`CGameEffectBounceSchool` * :ref:`CGameEffectBounceSecondaryTypeDecrement` * :ref:`CGameEffectBounceSecondaryType` * :ref:`CGameEffectBounceSpell` * :ref:`CGameEffectCHR` * :ref:`CGameEffectCON` * :ref:`CGameEffectCalm` * :ref:`CGameEffectCannotSaveOrRest` * :ref:`CGameEffectCastSpellPoint` * :ref:`CGameEffectCastSpell` * :ref:`CGameEffectCastingFailure` * :ref:`CGameEffectCastingGlow` * :ref:`CGameEffectCastingLevelBonus` * :ref:`CGameEffectChangeStatic` * :ref:`CGameEffectChangeWeather` * :ref:`CGameEffectChaosShield` * :ref:`CGameEffectCheckForBerserk` * :ref:`CGameEffectClairvoyance` * :ref:`CGameEffectClassStringOverride` * :ref:`CGameEffectCleanAir` * :ref:`CGameEffectColorChange` * :ref:`CGameEffectColorGlowDissipate` * :ref:`CGameEffectColorGlowPulse` * :ref:`CGameEffectColorLightSolid` * :ref:`CGameEffectColorTintSolid` * :ref:`CGameEffectConfusion` * :ref:`CGameEffectContingencyInstance` * :ref:`CGameEffectContingencyStart` * :ref:`CGameEffectCopySelf` * :ref:`CGameEffectCreateItem` * :ref:`CGameEffectCreateWeapon` * :ref:`CGameEffectCriticalHitBonus` * :ref:`CGameEffectCriticalHitSpell` * :ref:`CGameEffectCriticalMissModifier` * :ref:`CGameEffectCriticalMissSpell` * :ref:`CGameEffectCureBlindness` * :ref:`CGameEffectCureDeafness` * :ref:`CGameEffectCureDisease` * :ref:`CGameEffectCureFeebleMindedness` * :ref:`CGameEffectCurePoison` * :ref:`CGameEffectDEX` * :ref:`CGameEffectDamageLuck` * :ref:`CGameEffectDamageMod` * :ref:`CGameEffectDamageVisualEffect` * :ref:`CGameEffectDeafness` * :ref:`CGameEffectDefrost` * :ref:`CGameEffectDestroyItem` * :ref:`CGameEffectDestroySelf` * :ref:`CGameEffectDestroyWeapon` * :ref:`CGameEffectDetectAlignment` * :ref:`CGameEffectDetectIllusion` * :ref:`CGameEffectDetectTraps` * :ref:`CGameEffectDisableButton` * :ref:`CGameEffectDisableCircle` * :ref:`CGameEffectDisableSpellType` * :ref:`CGameEffectDisintegrate` * :ref:`CGameEffectDispelEffects` * :ref:`CGameEffectDispelInvisible` * :ref:`CGameEffectDispelSanctuary` * :ref:`CGameEffectDispelSchoolOne` * :ref:`CGameEffectDispelSchool` * :ref:`CGameEffectDispelSecondaryTypeOne` * :ref:`CGameEffectDispelSecondaryType` * :ref:`CGameEffectDisplayString` * :ref:`CGameEffectDither` * :ref:`CGameEffectDrainChargeFromAllItems` * :ref:`CGameEffectDurationCasting` * :ref:`CGameEffectEnableButton` * :ref:`CGameEffectEndNonDetection` * :ref:`CGameEffectEntangle` * :ref:`CGameEffectEquipWeapon` * :ref:`CGameEffectEvadeAreaOfEffect` * :ref:`CGameEffectExistanceDelayOverride` * :ref:`CGameEffectExplore` * :ref:`CGameEffectFamiliarBlock` * :ref:`CGameEffectFatigue` * :ref:`CGameEffectFeebleMindedness` * :ref:`CGameEffectFindFamiliar` * :ref:`CGameEffectFistDamageBonus` * :ref:`CGameEffectFistTHAC0Bonus` * :ref:`CGameEffectFloatText` * :ref:`CGameEffectForceSurge` * :ref:`CGameEffectForceVisible` * :ref:`CGameEffectFreedom` * :ref:`CGameEffectGold` * :ref:`CGameEffectGreasePool` * :ref:`CGameEffectHaste2` * :ref:`CGameEffectHaste` * :ref:`CGameEffectHideInShadows` * :ref:`CGameEffectHighLevelAbility` * :ref:`CGameEffectHitMod` * :ref:`CGameEffectHitPointsOnDeath` * :ref:`CGameEffectHoldCreature` * :ref:`CGameEffectINT` * :ref:`CGameEffectIdentify` * :ref:`CGameEffectIgnoreDialogPause` * :ref:`CGameEffectIgnoreDrainDeath` * :ref:`CGameEffectIgnoreReputationBreak` * :ref:`CGameEffectImmuneToTracking` * :ref:`CGameEffectImmuneToWeapon` * :ref:`CGameEffectImmunitySchoolDecrement` * :ref:`CGameEffectImmunitySchool` * :ref:`CGameEffectImmunitySecondaryTypeDecrement` * :ref:`CGameEffectImmunitySecondaryType` * :ref:`CGameEffectImmunitySpellIWD` * :ref:`CGameEffectImmunitySpell` * :ref:`CGameEffectImmunityToBackstab` * :ref:`CGameEffectImmunityToDisplayString` * :ref:`CGameEffectImmunityToPortraitIcon` * :ref:`CGameEffectImmunityToProjectile` * :ref:`CGameEffectImmunityToSequester` * :ref:`CGameEffectImmunityToSpellLevel` * :ref:`CGameEffectImmunityToTimeStop` * :ref:`CGameEffectImmunityToTurnUndead` * :ref:`CGameEffectImmunityToVisualEffect` * :ref:`CGameEffectImprisonment` * :ref:`CGameEffectInfravisionOff` * :ref:`CGameEffectInfravision` * :ref:`CGameEffectIntoxication` * :ref:`CGameEffectInvisible` * :ref:`CGameEffectJumpToArea` * :ref:`CGameEffectJumpToPocketPlane` * :ref:`CGameEffectKnock` * :ref:`CGameEffectLearnSpell` * :ref:`CGameEffectLevelRestoration` * :ref:`CGameEffectLevel` * :ref:`CGameEffectLore` * :ref:`CGameEffectLuck` * :ref:`CGameEffectMeleeDamageBonus` * :ref:`CGameEffectMeleeEffect` * :ref:`CGameEffectMeleeTHAC0Bonus` * :ref:`CGameEffectMentalSpeed` * :ref:`CGameEffectMinHitPoints` * :ref:`CGameEffectMinorGlobe` * :ref:`CGameEffectMirrorImageRun` * :ref:`CGameEffectMirrorImage` * :ref:`CGameEffectMissileDamageBonus` * :ref:`CGameEffectMissileTHAC0Bonus` * :ref:`CGameEffectMoraleBreak` * :ref:`CGameEffectMorale` * :ref:`CGameEffectMovementRateModal` * :ref:`CGameEffectMovementRate` * :ref:`CGameEffectNPCBump` * :ref:`CGameEffectName` * :ref:`CGameEffectNoPermanentDeath` * :ref:`CGameEffectNonDetection` * :ref:`CGameEffectNon_CumulativeAid` * :ref:`CGameEffectNon_CumulativeBless` * :ref:`CGameEffectNon_CumulativeChantBad` * :ref:`CGameEffectNon_CumulativeChant` * :ref:`CGameEffectNon_CumulativeDrawUponHolyMight` * :ref:`CGameEffectNon_CumulativeLuck` * :ref:`CGameEffectOverrideWeaponType` * :ref:`CGameEffectPanic` * :ref:`CGameEffectPauseCaster` * :ref:`CGameEffectPetrification` * :ref:`CGameEffectPhysicalSpeed` * :ref:`CGameEffectPlayMovie` * :ref:`CGameEffectPlaySound` * :ref:`CGameEffectPortraitIcon` * :ref:`CGameEffectPowerWordKill` * :ref:`CGameEffectPreventAISlowDown` * :ref:`CGameEffectPreventSpellProtectionEffects` * :ref:`CGameEffectProficiency` * :ref:`CGameEffectProtectionCircle` * :ref:`CGameEffectProtectionFromCreature` * :ref:`CGameEffectPuppetMaster` * :ref:`CGameEffectRandomDrop` * :ref:`CGameEffectRandomPhase` * :ref:`CGameEffectRandomSummon` * :ref:`CGameEffectRandomTeleport` * :ref:`CGameEffectRangeEffect` * :ref:`CGameEffectRememorizeSpell` * :ref:`CGameEffectRemoveAllOfType` * :ref:`CGameEffectRemoveConfusion` * :ref:`CGameEffectRemoveCurse` * :ref:`CGameEffectRemoveEffectOfResource` * :ref:`CGameEffectRemoveHold` * :ref:`CGameEffectRemoveInnateAbility` * :ref:`CGameEffectRemoveIntoxication` * :ref:`CGameEffectRemovePanic` * :ref:`CGameEffectRemovePortraitIcon` * :ref:`CGameEffectRemoveRandomSpell` * :ref:`CGameEffectRemoveSpellImmunity` * :ref:`CGameEffectRepeatingApplyEffect` * :ref:`CGameEffectReplaceItem` * :ref:`CGameEffectReplaceSelf` * :ref:`CGameEffectReputation` * :ref:`CGameEffectResistAcid` * :ref:`CGameEffectResistCold` * :ref:`CGameEffectResistCrushing` * :ref:`CGameEffectResistElectricity` * :ref:`CGameEffectResistFire` * :ref:`CGameEffectResistMagicCold` * :ref:`CGameEffectResistMagicFire` * :ref:`CGameEffectResistMagic` * :ref:`CGameEffectResistMissile` * :ref:`CGameEffectResistPiercing` * :ref:`CGameEffectResistSlashing` * :ref:`CGameEffectResistanceToMagic` * :ref:`CGameEffectResistanceToPoison` * :ref:`CGameEffectRest` * :ref:`CGameEffectRestoreMovementRate` * :ref:`CGameEffectRestrictEquipItemType` * :ref:`CGameEffectRestrictEquipItem` * :ref:`CGameEffectResurrectParty` * :ref:`CGameEffectResurrect` * :ref:`CGameEffectRetreatFrom` * :ref:`CGameEffectRevealMagic` * :ref:`CGameEffectSTRExtra` * :ref:`CGameEffectSTR` * :ref:`CGameEffectSanctuary` * :ref:`CGameEffectSaveVsBreath` * :ref:`CGameEffectSaveVsDeath` * :ref:`CGameEffectSaveVsPoly` * :ref:`CGameEffectSaveVsSchoolMod` * :ref:`CGameEffectSaveVsSpell` * :ref:`CGameEffectSaveVsWands` * :ref:`CGameEffectSavingThrowChange` * :ref:`CGameEffectScreenShake` * :ref:`CGameEffectScriptingState` * :ref:`CGameEffectSecondaryCastList` * :ref:`CGameEffectSeeInvisible` * :ref:`CGameEffectSelectiveDamageBonus` * :ref:`CGameEffectSelectiveEnchantmentBonus` * :ref:`CGameEffectSelectiveToHitBonus` * :ref:`CGameEffectSequencerFirePoint` * :ref:`CGameEffectSequencerFire` * :ref:`CGameEffectSequencerInstance` * :ref:`CGameEffectSequencerStart` * :ref:`CGameEffectSetAIScript` * :ref:`CGameEffectSetDoNotJump` * :ref:`CGameEffectSetGlobal` * :ref:`CGameEffectSetLocalExternal` * :ref:`CGameEffectSetLocalVariable` * :ref:`CGameEffectSetSequence` * :ref:`CGameEffectSetSnare` * :ref:`CGameEffectSetSpellState` * :ref:`CGameEffectSetTrap` * :ref:`CGameEffectSevenEyesRun` * :ref:`CGameEffectShieldGlobe` * :ref:`CGameEffectShowArea` * :ref:`CGameEffectShowCreatures` * :ref:`CGameEffectSilence` * :ref:`CGameEffectSingleColorPulseAll` * :ref:`CGameEffectSkillLockPicking` * :ref:`CGameEffectSkillPickPocket` * :ref:`CGameEffectSkillStealth` * :ref:`CGameEffectSkillTracking` * :ref:`CGameEffectSkillTraps` * :ref:`CGameEffectSlay` * :ref:`CGameEffectSleep` * :ref:`CGameEffectSlowPoison` * :ref:`CGameEffectSlow` * :ref:`CGameEffectSparkle` * :ref:`CGameEffectSpecificDamageMod` * :ref:`CGameEffectSpellMemorizationCleric` * :ref:`CGameEffectSpellMemorizationMage` * :ref:`CGameEffectSpellTrapLevelDecrement` * :ref:`CGameEffectStoneToFlesh` * :ref:`CGameEffectStun` * :ref:`CGameEffectSummonDisable` * :ref:`CGameEffectSurgeMod` * :ref:`CGameEffectSwapHitpoints` * :ref:`CGameEffectTeleport` * :ref:`CGameEffectThac0Left` * :ref:`CGameEffectThac0Right` * :ref:`CGameEffectThac0` * :ref:`CGameEffectTimeStop` * :ref:`CGameEffectTracking` * :ref:`CGameEffectTranslucent` * :ref:`CGameEffectTurnUndeadModifier` * :ref:`CGameEffectTurnUndead` * :ref:`CGameEffectUnpauseCaster` * :ref:`CGameEffectUnstun` * :ref:`CGameEffectUnsummon` * :ref:`CGameEffectUsability` * :ref:`CGameEffectUseAnyItem` * :ref:`CGameEffectVisible` * :ref:`CGameEffectVisualAnimationEffect` * :ref:`CGameEffectVisualEffect` * :ref:`CGameEffectVisualRange` * :ref:`CGameEffectVisualSpellHitIWD` * :ref:`CGameEffectVisualSpellHit` * :ref:`CGameEffectVocalize` * :ref:`CGameEffectWIS` * :ref:`CGameEffectWebHold` * :ref:`CGameEffectWish` * :ref:`CGameEffectXP` ---- .. _CGameEffectEffect_Specific: Specific CGameEffect\ Classes -------------------------------------- .. note:: The following class names also apply to the above documentation, but also contain additional class methods. They are listed here as well for completeness as they share the same basic class methods, but they are documented individually as well due to the additional class methods they contain - see the specific class for details. .. toctree:: :maxdepth: 1 CGameEffectAlignmentReversal CGameEffectAnimationChange CGameEffectApplyEffect CGameEffectBase CGameEffectBlindness CGameEffectBounceLevelDecrement CGameEffectCharm CGameEffectColorGlowSolid CGameEffectCurseApplyEffect CGameEffectDamage CGameEffectDeath CGameEffectDisease CGameEffectDoNotDraw CGameEffectFile CGameEffectHeal CGameEffectHitPoints CGameEffectHoldCreatureSpell CGameEffectImmunityLevelDecrement CGameEffectImmunityToEffect CGameEffectList CGameEffectMakeUnselectable CGameEffectMaze CGameEffectOverrideAnimation CGameEffectPoison CGameEffectPolymorph CGameEffectPortrait CGameEffectPowerWordSleep CGameEffectPowerWordStun CGameEffectPushPull CGameEffectRegeneration CGameEffectSevenEyes CGameEffectSexChange CGameEffectStaticCharge CGameEffectStoneSkins CGameEffectStoneSkinsGolem CGameEffectSummon